Skip to main content
POST
What the credential's workspace used, from its usage events: summed per SKU over each window of the period and each `group_by` dimension, running work counted through now.

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json

cf. AWS Cost Explorer GetCostAndUsage (TimePeriod, Granularity, GroupBy, Filter).

startTime
string<date-time>

Usage that started at or after start_time and before end_time. Usage is cut at every hour, so a period of whole hours takes whole hours.

Example:

"2023-01-15T01:30:15.01Z"

endTime
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

granularity
enum<string>

The windows the period is cut into; unspecified sums the whole period as one.

Available options:
GRANULARITY_UNSPECIFIED,
GRANULARITY_HOURLY,
GRANULARITY_DAILY,
GRANULARITY_MONTHLY
groupBy
enum<string>[]

What each window's usage is further summed by, besides its SKU.

A fact of usage it may be summed by, besides its SKU and window.

cf. AWS Cost Explorer GroupBy dimension keys; Cloud Billing's export columns.

Available options:
USAGE_DIMENSION_UNSPECIFIED,
USAGE_DIMENSION_SUBJECT,
USAGE_DIMENSION_PRINCIPAL,
USAGE_DIMENSION_RESOURCE
filter
filter · object

Only usage matching every set list.

Response

Success

cf. AWS Cost Explorer GetCostAndUsage ResultsByTime.

usages
Usage · object[]

By window, then SKU, then the grouped dimensions.